home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / UTIL / MOUSE / WIMPINFO / !WimpInfo / !Help next >
Text File  |  1995-08-03  |  5KB  |  134 lines
  1.  
  2.  
  3.                             !WimpInfo v1.20 Manual
  4.                             ——————————————————————
  5.  
  6. About !WimpInfo
  7. ———————————————
  8. !WimpInfo is a utility that displays info about
  9.  
  10.   • The position and button status of the mouse pointer
  11.   • A window on the screen
  12.   • An icon in a window
  13.   • Additionally, you can save any window as a Template file, together with
  14.     its private sprites
  15.  
  16. This info can be handy for programmers who are writing Wimp (desktop)
  17. applications.
  18.  
  19. !WimpInfo is FreeWare. For conditions of use, read the copyright notice at
  20. the end of this manual.
  21.  
  22.  
  23. How to use
  24. ——————————
  25. When the program starts, it installs an icon on the icon bar. Click MENU on
  26. it, and select which info you want to see. The info is shown in a window.
  27.  
  28. Click ADJUST to close all the info windows. When you later click SELECT, the
  29. situation is restored, i.e. the windows that were closed by the ADJUST-click
  30. are opened again.
  31.  
  32. The 'Window info' and 'Icon info' windows can show extended info. Click on
  33. the 'Toggle size' icon.
  34.  
  35. If the option 'Shift-activated' is on, the info windows are only updated when
  36. the Shift key is pressed. This has two advantages:
  37.  
  38.   • It takes less processing power.
  39.   • You can 'freeze' the info, e.g. to compare two icons that are at some
  40.     distance from each other.
  41.  
  42. When the option is off updating is continuous.
  43.  
  44. If the option 'Grab Template' is on, the information of the window under the
  45. pointer can be saved as a template file when the Alt key is pressed. When the
  46. window you grab uses any other sprite areas than the Wimp sprite pool, the
  47. save box will allow you to switch between the Template file and a Sprite
  48. file. When you save this Sprite file, it will contain all sprite areas used
  49. in this window.
  50.  
  51.  
  52. Technical
  53. —————————
  54. WimpInfo is written to work on any version of RISC OS, however it was mostly
  55. tested on RISC OS 3.10. Let me know if there are any problems on other
  56. versions of RISC OS.
  57.  
  58. The program reserves a reasonable buffer to hold the template data which is
  59. decoded at the moment you press Alt. The window's sprite areas can however be
  60. very large and they are only read when you save the file. This means that you
  61. can still save the Template file after you quit the window's application, but
  62. the application must still be running when you save the Sprite file.
  63.  
  64. The saved Template file is not an exact copy of the window data. WimpInfo
  65. checks and fixes things which are not possible in Template files:
  66.   • All strings in a Template file are terminated by character 13
  67.   • All sprite areas are set to the Wimp sprite pool
  68.   • Sprite pointers are converted to sprite names
  69.   • If the given indirected icon max data length is less than the actual
  70.     length, the actual lenght is used instead
  71.   • The data of deleted icons is set to a constant value, Wimp_LoadTemplate
  72.     will complain if the data of a deleted icon is illegeal :-(
  73.   • WimpInfo will complain about illegal indirection pointers, it then uses
  74.     the truncated data if possible and still generates a valid Template
  75.  
  76. The program uses a fixed sized buffer to hold the template data. This can
  77. give the message "Too many icons/indirected data/fonts/sprite areas in this
  78. template" when you try to grab a very complex window, the template can not be
  79. saved. The maximum sizes for the buffers can be increased in the following
  80. lines in the source:
  81.  
  82. 1550 max_ic%=100   : REM Max allowed icons in saved template
  83. 1560 max_ind%=2048 : REM Max size of indirected data
  84. 1570 max_fonts%=10 : REM Max nr. of different fonts in a window
  85. 1580 max_areas%=10 : REM Max allowed different (non-Wimp) sprite areas in a window
  86.  
  87. The !RunImage file is a crunched version of Source. !RunImage just about runs
  88. in a 32k WimpSlot, source needs a 64k WimpSlot or more when you increase the
  89. buffers significantly.
  90.  
  91. I had some trouble to get v1.20 crunched into a 32k WimpSlot. It seems to
  92. work now, but try increasing the WimpSlot if the program behaves strangely.
  93.  
  94.  
  95. History
  96. ———————
  97. 1.00 Dick Alstein's original version. Provides information windows for:
  98.        • position and button status of the mouse
  99.        • window under the pointer
  100.        • icon under the pointer
  101.  
  102. 1.10 Unreleased version. Additions by Gert-Jan de Vos:
  103.        • DragASprite support and 3D Templates according to CMOS bits
  104.        • windows can be saved as a Template file
  105.  
  106. 1.20 Numerous bugfixes from 1.10 and some additions:
  107.        • hourglass is shown for long decoding/saving
  108.        • private sprite areas can be saved as well
  109.        • size of icon/window/work area is shown next to coordinates
  110.  
  111.  
  112. Copyright notice
  113. ————————————————
  114. This program is FreeWare. This means that I retain the copyright, except for
  115. the MenuUtils module, which is © Alex Petrov. You may freely copy and
  116. distribute it, provided that it is complete with all original files, and that
  117. you do not sell it. PD libraries may charge a nominal fee for the cost of
  118. duplication, postage etc. When you use the program, you do so entirely at
  119. your own risk. You may change the program to suit your own needs. If it's a
  120. bug fix, or if you think it's an improvement, then please send the changes to
  121. me.
  122.  
  123. Dick Alstein
  124. Lijnslagerstraat 204
  125. 5625 BP  Eindhoven
  126. The Netherlands
  127.  
  128. Template/sprite save additions by:
  129. Gert-Jan de Vos
  130. Benedenbeekloop 18
  131. 5662 HL Geldrop
  132. The Netherlands
  133. devos@eb.ele.tue.nl
  134.